Fix invalid examples and broken links in the docs#413
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several documentation examples on the 3.x line fail when copied because they are not valid YAML or describe configurations that AWS rejects, and a few internal links are broken. This fixes the ALB event page, which had a duplicated host condition key and trailing commas on the Cognito and OIDC authorizer values, and it removes the stray document separators embedded inside the MSK and API Gateway examples. It changes the CloudFront example so includeBody is paired with a viewer-request event rather than viewer-response, which CloudFront does not allow. It also points the services guide deploy link and the two custom-configuration plugin links at their correct paths and splits a run-together note in the deployment guide into two readable notes. These are the same defects already corrected on 4.x, limited here to the version-agnostic fixes that apply equally to 3.x.